﻿// <copyright file="IOutputParser.cs" company="Horiba Medical">
//     Copyright (c) Horiba Medical. All rights reserved.
// </copyright>
// <summary>
//     Output parser interface.
// </summary>

namespace DoxyOutParser.Parser
{
	using System.Collections.Generic;
	using System.Collections.ObjectModel;

	/// <summary>
	/// Defines a generalized parse method that a value type or class implements to generate a list of parsed entries.
	/// </summary>
	public interface IOutputParser
	{
		/// <summary>
		/// Parses a file according to a specified filter and returns an OutputEntry list.
		/// </summary>
		/// <param name="outputFile">Filter to parse.</param>
		/// <param name="filter">Searching filter.</param>
		/// <returns>Parsed list.</returns>
		OutputEntryCollection Parse(string outputFile, string filter);
	}
}
